<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensorshell;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.Map;<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>    import org.hackystat.sensorbase.resource.sensordata.jaxb.SensorData;<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>    /**<a name="line.7"></a>
<FONT color="green">008</FONT>     * An interface that is implemented by SensorShell and MultiSensorShell. This enables<a name="line.8"></a>
<FONT color="green">009</FONT>     * sensors that can restrict themselves to the use of the following public methods to<a name="line.9"></a>
<FONT color="green">010</FONT>     * easily toggle between the use of SensorShell or MultiSensorShell depending upon <a name="line.10"></a>
<FONT color="green">011</FONT>     * load requirements.<a name="line.11"></a>
<FONT color="green">012</FONT>     * <a name="line.12"></a>
<FONT color="green">013</FONT>     * As a simple example, a sensor might contain code similar to the following:<a name="line.13"></a>
<FONT color="green">014</FONT>     * &lt;pre&gt;<a name="line.14"></a>
<FONT color="green">015</FONT>     * boolean useMulti = isMultiSensorShellRequested();<a name="line.15"></a>
<FONT color="green">016</FONT>     * Shell shell = (useMulti) ? new MultiSensorShell(...) : new SensorShell(...);<a name="line.16"></a>
<FONT color="green">017</FONT>     *  :<a name="line.17"></a>
<FONT color="green">018</FONT>     * shell.add(...)<a name="line.18"></a>
<FONT color="green">019</FONT>     *  :<a name="line.19"></a>
<FONT color="green">020</FONT>     * shell.quit()<a name="line.20"></a>
<FONT color="green">021</FONT>     * &lt;/pre&gt;<a name="line.21"></a>
<FONT color="green">022</FONT>     * Thus, the decision to use a SensorShell vs. a MultiSensorShell can be made at run-time.<a name="line.22"></a>
<FONT color="green">023</FONT>     *   <a name="line.23"></a>
<FONT color="green">024</FONT>     * @author Philip Johnson<a name="line.24"></a>
<FONT color="green">025</FONT>     */<a name="line.25"></a>
<FONT color="green">026</FONT>    public interface Shell {<a name="line.26"></a>
<FONT color="green">027</FONT>      <a name="line.27"></a>
<FONT color="green">028</FONT>      /**<a name="line.28"></a>
<FONT color="green">029</FONT>       * Adds the passed SensorData instance to the Shell.<a name="line.29"></a>
<FONT color="green">030</FONT>       * <a name="line.30"></a>
<FONT color="green">031</FONT>       * @param sensorData The SensorData instance to be queued for transmission.<a name="line.31"></a>
<FONT color="green">032</FONT>       */<a name="line.32"></a>
<FONT color="green">033</FONT>      public void add(SensorData sensorData);<a name="line.33"></a>
<FONT color="green">034</FONT>      <a name="line.34"></a>
<FONT color="green">035</FONT>      /**<a name="line.35"></a>
<FONT color="green">036</FONT>       * Converts the values in the KeyValMap to a SensorData instance and adds it to the<a name="line.36"></a>
<FONT color="green">037</FONT>       * Shell. Owner will default to the hackystat user in the sensor.properties file.<a name="line.37"></a>
<FONT color="green">038</FONT>       * Timestamp and Runtime will default to the current time.<a name="line.38"></a>
<FONT color="green">039</FONT>       * <a name="line.39"></a>
<FONT color="green">040</FONT>       * @param keyValMap The map of key-value pairs.<a name="line.40"></a>
<FONT color="green">041</FONT>       * @throws Exception If the Map cannot be translated into SensorData, typically because a value<a name="line.41"></a>
<FONT color="green">042</FONT>       * was passed for Timestamp or Runtime that could not be parsed into XMLGregorianCalendar.<a name="line.42"></a>
<FONT color="green">043</FONT>       */<a name="line.43"></a>
<FONT color="green">044</FONT>      public void add(Map&lt;String, String&gt; keyValMap) throws Exception;<a name="line.44"></a>
<FONT color="green">045</FONT>      <a name="line.45"></a>
<FONT color="green">046</FONT>      /**<a name="line.46"></a>
<FONT color="green">047</FONT>       * Returns true if the host can be pinged and the email/password combination is valid.<a name="line.47"></a>
<FONT color="green">048</FONT>       * <a name="line.48"></a>
<FONT color="green">049</FONT>       * @return True if the host can be pinged and the user credentials are valid.<a name="line.49"></a>
<FONT color="green">050</FONT>       */<a name="line.50"></a>
<FONT color="green">051</FONT>      public boolean ping();<a name="line.51"></a>
<FONT color="green">052</FONT>      <a name="line.52"></a>
<FONT color="green">053</FONT>      /**<a name="line.53"></a>
<FONT color="green">054</FONT>       * Immediately invokes send() on this Shell. Note that you will rarely want<a name="line.54"></a>
<FONT color="green">055</FONT>       * to invoke this method. Instead, during normal operation you will rely on the<a name="line.55"></a>
<FONT color="green">056</FONT>       * autoSendTimeInterval to invoke send() in a separate thread, and then invoke quit() to invoke<a name="line.56"></a>
<FONT color="green">057</FONT>       * send() at the conclusion of the run.<a name="line.57"></a>
<FONT color="green">058</FONT>       * @return The total number of instances sent by Shell. <a name="line.58"></a>
<FONT color="green">059</FONT>       */<a name="line.59"></a>
<FONT color="green">060</FONT>      public int send();<a name="line.60"></a>
<FONT color="green">061</FONT>      <a name="line.61"></a>
<FONT color="green">062</FONT>      /**<a name="line.62"></a>
<FONT color="green">063</FONT>       * Invokes quit() on this Shell, which invokes a final send() and closes any<a name="line.63"></a>
<FONT color="green">064</FONT>       * logging files.<a name="line.64"></a>
<FONT color="green">065</FONT>       */<a name="line.65"></a>
<FONT color="green">066</FONT>      public void quit();<a name="line.66"></a>
<FONT color="green">067</FONT>      <a name="line.67"></a>
<FONT color="green">068</FONT>      /**<a name="line.68"></a>
<FONT color="green">069</FONT>       * Sets the logging level to be used for this Shell.<a name="line.69"></a>
<FONT color="green">070</FONT>       * If the passed string cannot be parsed into a Level, then INFO is set by default.<a name="line.70"></a>
<FONT color="green">071</FONT>       * @param level The new Level.<a name="line.71"></a>
<FONT color="green">072</FONT>       */<a name="line.72"></a>
<FONT color="green">073</FONT>      public void setLoggingLevel(String level);<a name="line.73"></a>
<FONT color="green">074</FONT>    <a name="line.74"></a>
<FONT color="green">075</FONT>    }<a name="line.75"></a>




























































</PRE>
</BODY>
</HTML>
